chore: harden recently updated scripts #3680

castastrophe · 2025-04-18T19:23:12Z

Description

Hind-sight is 20:20! I found a couple super minor updates to the scripts I recently worked on for the style-dictionary and Windows compatibility effort. I added notes inline to the code to help clarify these updates. It should just ensure we get more predictable results.

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

yarn builder tokens (@rise-erpelding )

Regression testing

Validate:

The documentation pages for at least two other components are still loading, including:

The pages render correctly, are accessible, and are responsive.

If components have been modified, VRTs have been run on this branch:

VRTs have been run and looked at.
Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

To-do list

I have read the contribution guidelines.
I have updated relevant storybook stories and templates.
I have tested these changes in Windows High Contrast mode.
If my change impacts other components, I have tested to make sure they don't break.
If my change impacts documentation, I have updated the documentation accordingly.
✨ This pull request is ready to merge. ✨

changeset-bot · 2025-04-18T19:23:15Z

⚠️ No Changeset found

Latest commit: f4571b3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2025-04-18T19:31:48Z

File metrics

Summary

Total size: 2.25 MB^*

🎉 No changes detected in any packages

* Size is the sum of all main files for packages in the library.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

github-actions · 2025-04-18T19:32:25Z

🚀 Deployed on https://pr-3680--spectrum-css.netlify.app

castastrophe · 2025-04-22T15:00:01Z

.github/workflows/development.yml

@@ -137,6 +137,8 @@ jobs:
            styles_modified_files: ${{ needs.changed_files.outputs.styles_modified_files }}
            eslint_added_files: ${{ needs.changed_files.outputs.eslint_added_files }}
            eslint_modified_files: ${{ needs.changed_files.outputs.eslint_modified_files }}
+            mdlint_added_files: ${{ needs.changed_files.outputs.mdlint_added_files }}


These exports don't seem to be working so we're linking just all the files!

castastrophe · 2025-04-22T15:00:36Z

.storybook/assets/base.css

@@ -29,16 +29,31 @@ body {
 }

 .spectrum {
+	/* Gradient that changes with the color theme. */
+	--spectrum-examples-gradient: linear-gradient(45deg, var(--spectrum-magenta-1500), var(--spectrum-blue-1500));


These variables are specific to the Storybook so I think it makes sense to move their definitions here instead of inside the tokens package. I didn't remove them though in case downstream customers are leveraging them as well.

castastrophe · 2025-04-22T15:00:54Z

.storybook/assets/base.css

 	color: var(--spectrum-neutral-content-color-default);
 	background-color: var(--spectrum-background-base-color);
-	-webkit-tap-highlight-color: rgba(0, 0, 0, 0%);
+	-webkit-tap-highlight-color: rgb(0, 0, 0, 0%);


This was just an auto-fix ala VSCode stylelinting

Can you say more about this and the other change below from hsla to hsl? I would have thought it'd be more correct to use rgba and hsla, but it seems like that's not the case.

I just learned about this the other day too! Apparently rgba and hsla are actually just aliases for rgb and hsl! PostCSS preset env tooling suggests we use the color function directly instead of the alias.

castastrophe · 2025-04-22T15:01:18Z

tasks/clean-up-after-migration.sh

-# Legacy tools folder (included storybook & generator)
-# test -d "tools" && rm -rf tools
-
-test -d "tools" && rm -rf tools


Not sure why this is still here - we like and need the tools folder!!

castastrophe · 2025-04-22T15:01:37Z

tokens/utilities/data-json-formatter.js

@@ -9,7 +9,7 @@ export const format = ({ dictionary, platform, file, options }) => {
 	);

 	const convertRef = (ref) => {
-		return ref.replace(/\{(.*?)\}/g, `var(--${prefix}-$1)`);
+		return ref?.toString()?.replace(/\{(.*?)\}/g, `var(--${prefix}-$1)`);


Sometimes ref is a number so this converts it to a string so we can tidy it up first

castastrophe · 2025-04-22T15:01:59Z

tokens/utilities/data-json-formatter.js

@@ -23,11 +23,11 @@ export const format = ({ dictionary, platform, file, options }) => {
 			if (data.ref) {
 				data.ref = convertRef(data.ref);

-				if (data.ref === data.value) {
+				if (data.ref?.toString() === data.value?.toString()) {


This just ensures that the ref is converted to the same type before comparing (sometimes they're numbers).

rise-erpelding

No issues here! Just left a small question. Also, thanks so much for all the helpful comments you added in the PR!

rise-erpelding · 2025-04-24T17:01:54Z

.storybook/assets/base.css

 	color: var(--spectrum-neutral-content-color-default);
 	background-color: var(--spectrum-background-base-color);
-	-webkit-tap-highlight-color: rgba(0, 0, 0, 0%);
+	-webkit-tap-highlight-color: rgb(0, 0, 0, 0%);


Can you say more about this and the other change below from hsla to hsl? I would have thought it'd be more correct to use rgba and hsla, but it seems like that's not the case.

chore: harden recently updated scripts

f4571b3

castastrophe force-pushed the chore-harden-scripts branch from 6805649 to f4571b3 Compare April 18, 2025 19:26

castastrophe commented Apr 22, 2025

View reviewed changes

castastrophe self-assigned this Apr 22, 2025

castastrophe marked this pull request as ready for review April 22, 2025 15:06

castastrophe added size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. ready-for-review labels Apr 22, 2025

rise-erpelding approved these changes Apr 24, 2025

View reviewed changes

castastrophe merged commit 16d14dd into main Apr 24, 2025
32 of 34 checks passed

castastrophe deleted the chore-harden-scripts branch April 24, 2025 17:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: harden recently updated scripts #3680

chore: harden recently updated scripts #3680

Uh oh!

castastrophe commented Apr 18, 2025 •

edited by rise-erpelding

Loading

Uh oh!

changeset-bot bot commented Apr 18, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 18, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 18, 2025 •

edited

Loading

Uh oh!

castastrophe Apr 22, 2025

Uh oh!

castastrophe Apr 22, 2025

Uh oh!

castastrophe Apr 22, 2025

Uh oh!

rise-erpelding Apr 24, 2025

Uh oh!

castastrophe Apr 24, 2025

Uh oh!

castastrophe Apr 22, 2025

Uh oh!

castastrophe Apr 22, 2025

Uh oh!

castastrophe Apr 22, 2025

Uh oh!

rise-erpelding left a comment •

edited

Loading

Uh oh!

rise-erpelding Apr 24, 2025

Uh oh!

Uh oh!

Uh oh!

chore: harden recently updated scripts #3680

chore: harden recently updated scripts #3680

Uh oh!

Conversation

castastrophe commented Apr 18, 2025 • edited by rise-erpelding Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How and where has this been tested?

Validation steps

Regression testing

To-do list

Uh oh!

changeset-bot bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

File metrics

Summary

Uh oh!

github-actions bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rise-erpelding left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

castastrophe commented Apr 18, 2025 •

edited by rise-erpelding

Loading

changeset-bot bot commented Apr 18, 2025 •

edited

Loading

github-actions bot commented Apr 18, 2025 •

edited

Loading

github-actions bot commented Apr 18, 2025 •

edited

Loading

rise-erpelding left a comment •

edited

Loading